Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

type-check mdx files, components, add narrow type to inline filter #7306

Closed
wants to merge 12 commits into from
Closed

type-check mdx files, components, add narrow type to inline filter #7306

wants to merge 12 commits into from

Conversation

josefaidt
Copy link
Contributor

Description of changes:

  • mv data/platforms to constants/platforms
  • refactor platforms constants
  • refactor frameworks constants
  • narrow type for InlineFilter's filters prop
  • define types for MDX page props
  • declare global types for MDX page props
  • declare global types for MDX page components
  • adds MDX files to tsconfig for type-checking
  • enables MDX plugin to enable strict type-checking on MDX files

the completions can be a bit wonky in that they'll only show up if you have the corresponding closing tag, but it's a bit easier to tab through

CleanShot 2024-04-24 at 17 47 20
CleanShot 2024-04-24 at 17 47 39

Related GitHub issue #, if available:

Instructions

If this PR should not be merged upon approval for any reason, please submit as a DRAFT

Which product(s) are affected by this PR (if applicable)?

  • amplify-cli
  • amplify-ui
  • amplify-studio
  • amplify-hosting
  • amplify-libraries

Which platform(s) are affected by this PR (if applicable)?

  • JS
  • Swift
  • Android
  • Flutter
  • React Native

Please add the product(s)/platform(s) affected to the PR title

Checks

  • Does this PR conform to the styleguide?

  • Does this PR include filetypes other than markdown or images? Please add or update unit tests accordingly.

  • Are any files being deleted with this PR? If so, have the needed redirects been created?

  • Are all links in MDX files using the MDX link syntax rather than HTML link syntax?

    ref: MDX: [link](https://docs.amplify.aws/)
    HTML: <a href="https://docs.amplify.aws/">link</a>

When this PR is ready to merge, please check the box below

  • Ready to merge

By submitting this pull request, I confirm that my contribution is made under the terms of the Apache 2.0 license.

@josefaidt josefaidt requested review from a team and renebrandel as code owners April 25, 2024 00:48
@josefaidt josefaidt added the amplify/docs-engineering Issues with the docs site itself, NOT its content label Apr 25, 2024
@josefaidt josefaidt changed the base branch from next-release/main to main May 31, 2024 15:03
@katiegoines
Copy link
Contributor

katiegoines commented Jul 26, 2024 •
edited
Loading

@josefaidt - This looks good to me!

The accessibility scan is failing on this page because there are emojis in the BlockSwitcher names, which is getting caught up in the utility to convert names you implemented here. I think it can be cleared up by merging in main to your branch and adding the below to BlockSwitcher.tsx to check for and remove any emojis

 const convertNameToValue = (name: string) => {
    const emojiRegex = /\p{Emoji}/u;
    if (emojiRegex.test(name)) name = name.replaceAll(/\p{Emoji}/gu, '');
    return `${name.split(' ').join('-').toLowerCase()}-${uniqueId}`;
  };

This was referenced Jul 31, 2024
Open
Open
@josefaidt
Copy link
Contributor Author

Hey @katiegoines I split this into a few PR's to chunk out the updates. I'm going to close this one in favor of the two new PR's, and approach the refactor at a later time

@josefaidt josefaidt closed this Aug 1, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@katiegoines katiegoines katiegoines approved these changes

@renebrandel renebrandel Awaiting requested review from renebrandel

@hdworld11 hdworld11 Awaiting requested review from hdworld11

@dbanksdesign dbanksdesign Awaiting requested review from dbanksdesign

@ykethan ykethan Awaiting requested review from ykethan

@Jay2113 Jay2113 Awaiting requested review from Jay2113

@chrisbonifacio chrisbonifacio Awaiting requested review from chrisbonifacio

@aspittel aspittel Awaiting requested review from aspittel

@swaminator swaminator Awaiting requested review from swaminator

@ErikCH ErikCH Awaiting requested review from ErikCH

@arundna arundna Awaiting requested review from arundna

Assignees
No one assigned
Labels
amplify/docs-engineering Issues with the docs site itself, NOT its content
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@josefaidt @katiegoines